Purchase Correction

NEW! We now have our Interactive tool for this section.

Restores the full amount of a previous Purchase, Force Post or Pre-Authorization Completion transaction to the cardholder's card, and removes any record of it from the cardholder's statement.

This transaction is sometimes referred to as "void" or "correction".

This transaction can be used against a Purchase or Completion transaction that occurred same day provided that the batch containing the original transaction remains open. When using the automated closing feature, Batch Close occurs daily between 10 and 11pm Eastern Time.

If the batch has already closed, please refer to Refund.

Canada Code Sample


package Canada;

import JavaAPI.*;

public class TestCanadaPurchaseCorrection
{
	public static void main(String[] args)
	{
		String store_id = "store5";
		String api_token = "yesguy";
		String order_id = "Test1432065003686";
		String txn_number = "42014-0_10";
		String crypt = "7";
		String dynamic_descriptor = "123456";
		String processing_country_code = "CA";
		boolean status_check = false;

		PurchaseCorrection purchasecorrection = new PurchaseCorrection();
		purchasecorrection.setOrderId(order_id);
		purchasecorrection.setTxnNumber(txn_number);
		purchasecorrection.setCryptType(crypt);
		purchasecorrection.setDynamicDescriptor(dynamic_descriptor);
		purchasecorrection.setCustId("my customer id");

		HttpsPostRequest mpgReq = new HttpsPostRequest();
		mpgReq.setProcCountryCode(processing_country_code);
		mpgReq.setTestMode(true); //false or comment out this line for production transactions
		mpgReq.setStoreId(store_id);
		mpgReq.setApiToken(api_token);
		mpgReq.setTransaction(purchasecorrection);
		mpgReq.setStatusCheck(status_check);
		mpgReq.send();

		try
		{
			Receipt receipt = mpgReq.getReceipt();

			System.out.println("CardType = " + receipt.getCardType());
			System.out.println("TransAmount = " + receipt.getTransAmount());
			System.out.println("TxnNumber = " + receipt.getTxnNumber());
			System.out.println("ReceiptId = " + receipt.getReceiptId());
			System.out.println("TransType = " + receipt.getTransType());
			System.out.println("ReferenceNum = " + receipt.getReferenceNum());
			System.out.println("ResponseCode = " + receipt.getResponseCode());
			System.out.println("ISO = " + receipt.getISO());
			System.out.println("BankTotals = " + receipt.getBankTotals());
			System.out.println("Message = " + receipt.getMessage());
			System.out.println("AuthCode = " + receipt.getAuthCode());
			System.out.println("Complete = " + receipt.getComplete());
			System.out.println("TransDate = " + receipt.getTransDate());
			System.out.println("TransTime = " + receipt.getTransTime());
			System.out.println("Ticket = " + receipt.getTicket());
			System.out.println("TimedOut = " + receipt.getTimedOut());
			System.out.println("IsVisaDebit = " + receipt.getIsVisaDebit());
		}
		catch (Exception e)
		{
			e.printStackTrace();
		}
	}
}

Purchase Correction transaction object definition

PurchaseCorrection purchasecorrection = new PurchaseCorrection();

HttpsPostRequest object for Purchase Correction transaction

HttpsPostRequest mpgReq = new HttpsPostRequest();

mpgReq.setTransaction(purchasecorrection);

Purchase Correction transaction object mandatory values

Value Type Limits Set method Description

Order ID String 50-character alphanumeric purchasecorrection.setOrderId(order_id); Order ID of the previously registered recurring billing transaction. Merchant-defined transaction identifier that must be unique for every Purchase, Pre-Authorization and Independent Refund transaction. No two transactions of these types may have the same order ID.

For Refund, Completion and Purchase Correction transactions, the order ID must be the same as that of the original transaction.

The last 10 characters of the order ID are displayed in the “Invoice Number” field on the Merchant Direct Reports. However only letters, numbers and spaces are sent to Merchant Direct.

A minimum of 3 and a maximum of 10 valid characters are sent to Merchant Direct. Only the last characters beginning after any invalid characters are sent. For example, if the order ID is 1234-567890, only 567890 is sent to Merchant Direct.

If the order ID has fewer than 3 characters, it may display a blank or 0000000000 in the Invoice Number field.

Transaction number String 255-character alphanumeric purchasecorrection.setTxnNumber(txn_number); Used when performing follow-on transactions. (That is, Completion, Purchase Correction or Refund.) This must be the value that was returned as the transaction number in the response of the original transaction.

When performing a Completion, this value must reference the Pre-Authorization. When performing a Refund or a Purchase Correction, this value must reference the Completion or the Purchase.

E-Commerce indicator

String

1-character alphanumeric

Value	Type	Limits	Set method	Description
Order ID	String	50-character alphanumeric	`purchasecorrection.setOrderId(order_id);`	Order ID of the previously registered recurring billing transaction. Merchant-defined transaction identifier that must be unique for every Purchase, Pre-Authorization and Independent Refund transaction. No two transactions of these types may have the same order ID. For Refund, Completion and Purchase Correction transactions, the order ID must be the same as that of the original transaction. The last 10 characters of the order ID are displayed in the “Invoice Number” field on the Merchant Direct Reports. However only letters, numbers and spaces are sent to Merchant Direct. A minimum of 3 and a maximum of 10 valid characters are sent to Merchant Direct. Only the last characters beginning after any invalid characters are sent. For example, if the order ID is 1234-567890, only 567890 is sent to Merchant Direct. If the order ID has fewer than 3 characters, it may display a blank or 0000000000 in the Invoice Number field.
Transaction number	String	255-character alphanumeric	`purchasecorrection.setTxnNumber(txn_number);`	Used when performing follow-on transactions. (That is, Completion, Purchase Correction or Refund.) This must be the value that was returned as the transaction number in the response of the original transaction. When performing a Completion, this value must reference the Pre-Authorization. When performing a Refund or a Purchase Correction, this value must reference the Completion or the Purchase.
E-Commerce indicator	String	1-character alphanumeric	`purchasecorrection.setCryptType(crypt);`	Describes the category of e-commerce transaction being processed. Allowable values are: 1 - Mail Order / Telephone Order—Single 2 - Mail Order / Telephone Order—Recurring 3 - Mail Order / Telephone Order—Instalment 4 - Mail Order / Telephone Order—Unknown classification 5 - Authenticated e-commerce transaction (VBV) 6 - Non-authenticated e-commerce transaction (VBV) 7 - SSL-enabled merchant In Credential on File transactions where the request field e-commerce indicator is also being sent: the allowable values for e-commerce indicator are dependent on the value sent for payment indicator, as follows: if payment indicator = R, then allowable values for e-commerce indicator: 2, 5 or 6 if payment indicator = C, then allowable values for e-commerce indicator: 1, 5, 6 or 7 if payment indicator = U, then allowable values for e-commerce indicator: 1 or 7 if payment indicator = Z, then allowable values for e-commerce indicator: 1, 5, 6 or 7

purchasecorrection.setCryptType(crypt);

Describes the category of e-commerce transaction being processed. Allowable values are:

1 - Mail Order / Telephone Order—Single
2 - Mail Order / Telephone Order—Recurring
3 - Mail Order / Telephone Order—Instalment
4 - Mail Order / Telephone Order—Unknown classification
5 - Authenticated e-commerce transaction (VBV)
6 - Non-authenticated e-commerce transaction (VBV)
7 - SSL-enabled merchant

In Credential on File transactions where the request field e-commerce indicator is also being sent: the allowable values for e-commerce indicator are dependent on the value sent for payment indicator, as follows:

if payment indicator = R, then allowable values for e-commerce indicator: 2, 5 or 6
if payment indicator = C, then allowable values for e-commerce indicator: 1, 5, 6 or 7
if payment indicator = U, then allowable values for e-commerce indicator: 1 or 7
if payment indicator = Z, then allowable values for e-commerce indicator: 1, 5, 6 or 7

Purchase Correction transaction object optional values

Value	Type	Limits	Set method	Description
Status Check	Boolean	true/false	`mpgReq.setStatusCheck(status_check);`	Status Check is a connection object value that allows merchants to verify whether a previously sent transaction was processed successfully.
Customer ID	String	50-character alphanumeric	`purchasecorrection.setCustId(custid);`	This can be used for policy number, membership number, student ID, invoice number and so on. This field is searchable from the Moneris Merchant Resource Centre.
Dynamic Descriptor	String	20-character alphanumeric	`purchasecorrection.setDynamicDescriptor(dynamic_descriptor);`	Merchant defined description sent on a per-transaction basis that will appear on the credit card statement. Dependent on the card Issuer, the statement will typically show the dynamic desciptor appended to the merchant's existing business name separated by the "/" character. Please note that the combined length of the merchant's business name, forward slash "/" character, and the dynamic descriptor may not exceed 22 characters. -Example- Existing Business Name: ABC Painting Dynamic Descriptor: Booking 12345 Cardholder Statement Displays: ABC Painting/Booking 1

Moneris Developers_

My Profile_